//
// "$Id: Fl_Menu_Button.H 8864 2011-07-19 04:49:30Z greg.ercolano $"
//
// Menu button header file for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2010 by Bill Spitzak and others.
//
// This library is free software. Distribution and use rights are outlined in
// the file "COPYING" which should have been included with this file.  If this
// file is missing or damaged, see the license at:
//
//     http://www.fltk.org/COPYING.php
//
// Please report all bugs and problems on the following page:
//
//     http://www.fltk.org/str.php
//

/* \file
   Fl_Menu_Button widget . */

#ifndef Fl_Menu_Button_H
#define Fl_Menu_Button_H

#include "Fl_Menu_.H"

/**
  This is a button that when pushed pops up a menu (or hierarchy of
  menus) defined by an array of
  Fl_Menu_Item objects.
  <P ALIGN=CENTER>\image html  menu_button.png</P>
  \image latex  menu_button.png " menu_button" width=5cm
  <P>Normally any mouse button will pop up a menu and it is lined up
  below the button as shown in the picture.  However an Fl_Menu_Button
  may also control a pop-up menu.  This is done by setting the type().
  If type() is zero a normal menu button is produced.
  If it is nonzero then this is a pop-up menu. The bits in type() indicate
  what mouse buttons pop up the menu (see Fl_Menu_Button::popup_buttons). </P>
  <P>The menu will also pop up in response to shortcuts indicated by
  putting a '&' character in the label(). </P>
  <P>Typing the shortcut() of any of the menu items will cause
  callbacks exactly the same as when you pick the item with the mouse.
  The '&' character in menu item names are only looked at when the menu is
  popped up, however. </P>
  <P>When the user picks an item off the menu, the item's callback is
  done with the menu_button as the Fl_Widget* argument.  If the
  item does not have a callback the menu_button's callback is done
  instead.
*/
class FL_EXPORT Fl_Menu_Button : public Fl_Menu_
{
protected:
	void draw();
public:
	/**
	 \brief indicate what mouse buttons pop up the menu.

	 Values for type() used to indicate what mouse buttons pop up the menu.
	 Fl_Menu_Button::POPUP3 is usually what you want.
	 */
	enum popup_buttons {POPUP1 = 1, /**< pops up with the mouse 1st button. */
	                    POPUP2,  /**< pops up with the mouse 2nd button. */
	                    POPUP12, /**< pops up with the mouse 1st or 2nd buttons. */
	                    POPUP3,   /**< pops up with the mouse 3rd button. */
	                    POPUP13,  /**< pops up with the mouse 1st or 3rd buttons. */
	                    POPUP23,  /**< pops up with the mouse 2nd or 3rd buttons. */
	                    POPUP123 /**< pops up with any mouse button. */
	                   };
	int handle(int);
	const Fl_Menu_Item* popup();

	/**
	Creates a new Fl_Menu_Button widget using the given position,
	size, and label string. The default boxtype is FL_UP_BOX.
	<P>The constructor sets menu() to NULL.  See
	Fl_Menu_ for the methods to set or change the menu.
	*/
	Fl_Menu_Button(int X,int Y,int W,int H,const char *l=0) : Fl_Menu_(X,Y,W,H,l)
	{
		down_box(FL_NO_BOX);
	}
};

#endif

//
// End of "$Id: Fl_Menu_Button.H 8864 2011-07-19 04:49:30Z greg.ercolano $".
//
